cs-visual-time-sapi

This section describes the attributes and usage of the cs-visual-time-sapi, version v1. This System API interacts directly with the Visual Time API to perform insurance operations, policy management, document validation, accounting movements, and more.

💂️ Base Information

• API Title: cs-visual-time-sapi
• Version: v1
• Base URL: https://cs-visual-time-sapi-{env}-v1.us-e1.cloudhub.io/api/
• Environments: dev, qa, prod

🔑 Authentication

Required Headers

✨ Main Endpoints

🧑‍⚖️ Legal Persons & Insured

GET /customers/legal-persons/insured/cancel

• Description: Cancel insured from legal-person customers.
• Request & Response: See examples in examples/requests/get-cancel.json and examples/responses/get-cancel.json.

GET /customers/legal-persons/insured/migration

• Description: Inclusion of insured individuals in institutional insurance.
• Request & Response: See examples in examples/requests/get-migration.json and examples/responses/get-migration.json.

🏥 Insured Management

POST /insureds

• Description: Insert insured individuals into Visual Time system.
• Request & Response: See examples in examples/requests/post-insureds.json and examples/responses/post-insureds.json.

POST /reserve-policy-number

• Description: Reserve master policy number in Visual Time.
• Request & Response: See examples in examples/requests/post-reserve-policy-number.json and examples/responses/post-reserve-policy-number.json.

POST /create-policy

• Description: Create master policy in Visual Time.
• Request & Response: See examples in examples/requests/post-create-policy.json and examples/responses/post-create-policy.json.

POST /validate-restrictive-lists

• Description: Validate restrictive lists for insured individuals.
• Request & Response: See examples in examples/requests/post-validate-restrictive-lists.json and examples/responses/post-validate-restrictive-lists.json.

POST /create-receipt

• Description: Create receipt and accounting entry in Visual Time.
• Request & Response: See examples in examples/requests/post-create-receipt.json and examples/responses/post-create-receipt.json.

POST /create-accounting-movement

• Description: Create accounting entry.
• Request & Response: See examples in examples/requests/post-create-accounting-movement.json and examples/responses/post-create-accounting-movement.json.

POST /confirm-collection

• Description: Confirm successful collection of payment.
• Request & Response: See examples in examples/requests/post-confirm-collection.json and examples/responses/post-confirm-collection.json.

POST /notify-client-creation

• Description: Notify client creation result.
• Request & Response: See examples in examples/requests/post-notify-client-creation.json and examples/responses/post-notify-client-creation.json.

POST /request-document-validation

• Description: Request document validation.
• Request & Response: See examples in examples/requests/post-request-document-validation.json and examples/responses/post-request-document-validation.json.

GET /get-documents

• Description: Retrieve documents to verify.
• Request & Response: See examples in examples/requests/get-documents.json and examples/responses/get-documents.json.

POST /document-validation-result

• Description: Return document validation result.
• Request & Response: See examples in examples/requests/post-document-validation-result.json and examples/responses/post-document-validation-result.json.

POST /generate-payment-link

• Description: Generate payment link for the insured individual.
• Request & Response: See examples in examples/requests/post-generate-payment-link.json and examples/responses/post-generate-payment-link.json.

⚠️ Error Codes

📞 Support

For assistance, contact the Integration Services and Applications Coordination team.

Email: epalma@fgs.co

Last updated: May 2025